﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class SECSIHeader
 </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class SECSIHeader
 ">
  
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <meta property="docfx:navrel" content="../../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
  
  
  
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../../index.html">
                <img id="logo" class="svg" src="../../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader">


  <h1 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader" class="text-break">Class SECSIHeader
</h1>
  <div class="markdown level0 summary"><p>This class represents a SECS message header when a
SECS-II message is sent via the SECS-I transport layer.
Refer to the SEMI Standards covering E004 for more
information.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSHeader.html">SECSHeader</a></div>
    <div class="level2"><span class="xref">SECSIHeader</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSHeader.html#com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSHeader_SystemBytes">SECSHeader.SystemBytes</a>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.html">com.CIMthetics.CSharpSECSTools.SECSCommUtils</a></h6>
  <h6><strong>Assembly</strong>: SECSCommUtils.dll</h6>
  <h5 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class SECSIHeader : SECSHeader</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader__ctor_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.#ctor*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader__ctor" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.#ctor">SECSIHeader()</h4>
  <div class="markdown level1 summary"><p>This class represents a SECS message header when a
SECS-II message is sent via the SECS-I transport layer.
Refer to the SEMI Standards covering E004 for more
information.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SECSIHeader()</code></pre>
  </div>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader__ctor_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.#ctor*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader__ctor_com_CIMthetics_CSharpSECSTools_SECSCommUtils_HSMSHeader_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.#ctor(com.CIMthetics.CSharpSECSTools.SECSCommUtils.HSMSHeader)">SECSIHeader(HSMSHeader)</h4>
  <div class="markdown level1 summary"><p>This constructor will create a SECS-I message header from an HSMS
message header.  It needs to be understood that not all of the
attributes are present in both forms of a SECS message header.
There are only a few situations in which using this
constructor would make sense.  It might make sense in a situation
where an intermediary was &quot;translating&quot; messages from a device using
SECS-I as a transport layer to a device using HSMS as a transport
layer and vica versa.</p>
<p></p>
Note: A SessionID in an HSMS header is a 16 bit number whereas the
DeviceID in a SECS-I header is a 15 bit number.  You will get a
<code>ConstraintException</code> if the high bit in the SessionID is set
when you use this constructor.
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SECSIHeader(HSMSHeader header)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.HSMSHeader.html">HSMSHeader</a></td>
        <td><span class="parametername">header</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader__ctor_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.#ctor*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader__ctor_com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.#ctor(com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader)">SECSIHeader(SECSIHeader)</h4>
  <div class="markdown level1 summary"><p>This is a copy constructor.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SECSIHeader(SECSIHeader header)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.html">SECSIHeader</a></td>
        <td><span class="parametername">header</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader__ctor_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.#ctor*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader__ctor_System_Byte___" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.#ctor(System.Byte[])">SECSIHeader(Byte[])</h4>
  <div class="markdown level1 summary"><p>This class represents a SECS message header when a
SECS-II message is sent via the SECS-I transport layer.
Refer to the SEMI Standards covering E004 for more
information.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public SECSIHeader(byte[] header)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td><span class="parametername">header</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_BlockNumber_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.BlockNumber*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_BlockNumber" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.BlockNumber">BlockNumber</h4>
  <div class="markdown level1 summary"><p>Block Number - A message sent as more than one block is called
a multi-block message. The first block is given a block number
of one, and the block number is incremented by one for each
subsequent block until the entire message is sent. The blocks
of a multi-block message are sent in order. In a single-block
message, the block number must have a value of zero or one. The
maximum block number is 32,767. The upper block number is the
most significant portion of the block number.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public ushort BlockNumber { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.UInt16</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_DeviceID_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.DeviceID*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_DeviceID" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.DeviceID">DeviceID</h4>
  <div class="markdown level1 summary"><p>Device ID - The device ID defines the source or destination
of the message depending upon the value of the R-bit as shown
in Table 3. Device identification is a property of the equipment
and must be settable according to Section 8. The host can view
the device ID as a logical identifier connected with a physical
device within the equipment. The host has no device ID.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public ushort DeviceID { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.UInt16</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_Ebit_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.Ebit*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_Ebit" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.Ebit">Ebit</h4>
  <div class="markdown level1 summary"><p>End Bit (E-Bit) - The end bit (E-bit) is used to determine if a
block is the last block of a message. A value of one in the
E-bit means that the block is the last block. A value of zero
means that more blocks are to follow.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool Ebit { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_Function_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.Function*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_Function" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.Function">Function</h4>
  <div class="markdown level1 summary"><p>The function of the SECS-II message.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public byte Function { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_Rbit_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.Rbit*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_Rbit" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.Rbit">Rbit</h4>
  <div class="markdown level1 summary"><p>Reverse Bit (R-Bit) - The reverse bit (R-bit) signifies the
direction of a message. The R-bit is set to <code>false</code> for messages
sent from the host to the equipment and set to <code>true</code> for messages
sent from the equipment to the host. The
R-bit is included in the header so that the direction of
the message is contained in every block.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool Rbit { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_Stream_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.Stream*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_Stream" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.Stream">Stream</h4>
  <div class="markdown level1 summary"><p>The stream of the SECS-II message.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public byte Stream { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_Wbit_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.Wbit*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_Wbit" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.Wbit">Wbit</h4>
  <div class="markdown level1 summary"><p>Wait Bit (W-Bit) - The wait bit (W-bit) is used to indicate
that the sender of a primary message expects a reply. A
value of <code>true</code> in the W-bit means that a reply is expected. A
value of <code>false</code> in the W-bit means that no reply is expected.
The W-bit must be set to <code>false</code> in all secondary messages.
For multi-block messages, the sender must ensure that the W-bit
is the same in every block of the message.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool Wbit { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_EncodeForTransport_" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.EncodeForTransport*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSIHeader_EncodeForTransport" data-uid="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSIHeader.EncodeForTransport">EncodeForTransport()</h4>
  <div class="markdown level1 summary"><p>This class represents a SECS message header when a
SECS-II message is sent via the SECS-I transport layer.
Refer to the SEMI Standards covering E004 for more
information.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override byte[] EncodeForTransport()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSCommUtils.SECSHeader.html#com_CIMthetics_CSharpSECSTools_SECSCommUtils_SECSHeader_EncodeForTransport">SECSHeader.EncodeForTransport()</a></div>
</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In This Article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
      
      <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>
